/**
 * Software License, Version 1.0
 * 
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 * 
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the 
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For 
 * further information contact the Community Grids Lab at 
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and 
 * wherever such third-party acknowledgments normally appear.
 * 
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering, 
 * shall not be used to endorse or promote products derived from this software 
 * without prior written permission from Indiana University.  For written 
 * permission, please contact the Advanced Research and Technology Institute 
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering, 
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 * 
 *
 * Indiana University provides no reassurances that the source code provided 
 * does not infringe the patent or any other intellectual property rights of 
 * any other entity.  Indiana University disclaims any liability to any 
 * recipient for claims brought by any other entity based on infringement of 
 * intellectual property rights or otherwise.  
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO 
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF 
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS. 
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS", 
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.  
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR 
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION 
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.wsinfra.wsr.storage;

import cgl.narada.wsinfra.wsr.storage.impl.WsrGroupInfoImpl;
/** This provides operations for storing and retrieving information 
    pertaining to groups. Specifically the operations provided include
    <br>(a)Storing and Retrieving GroupInfo objects 
    <br>(b) Retrieving the list of all sent, received, created, expired,
    terminated and active sent and received Groups. 
    
    @author sima patel
    $Date: 2005/04/08 17:03:13 $
    $Revision: 1.4 $
*/

public interface WsrGroupInfoStorageOperations {

    /** Stores the GroupId that should be used while communicating
    with a given destination.
    This feature allows us to send messages reliably with minimal 
    intervention from the application.*/
    public void addDestinationGroupIdPair(String destination, String groupId) 
                throws WsrStorageException;
  

    /** Retrieve the GroupIds for a specific destination */
    public String[] getGroupIdsForDestination(String destination)
                    throws WsrStorageException;

  
    /** Retrieves the destination for a specific groupId */
    public String getDestinationForGroupId(String groupId)
                  throws WsrStorageException;
  
  
    /** Removes the destination/group identifier pair corresponding to this
    groupId */
    public void removeDestinationGroupIdPair(String groupId)
                throws WsrStorageException;
  
  
  
    /** Checks to see if there is a groupId/destination pair corresponding
    to the destination in question. */
    public boolean hasGroupIdForDestination(String destination) 
                   throws WsrStorageException;
    
    /** Retrieves the sequence number that was last Delivered on a given
    group. This method throws an exception if the group
    specified by groupId is an unknown one or if there are 
    storage related problems.  */
    public long getSequenceNumberLastDelivered(String groupId)
                throws WsrStorageException;


    /** A method which checks whether a certain group (irrespective of whether
    it is active/terminated/expired/timed-out) is a known group at this
    node */
    public boolean isKnownGroup(String groupId) 
                   throws WsrStorageException;
    
    /** A method which checks whether a certain group (irrespective of whether
    it is active/terminated/expired/timed-out) is a exits(from Sink point of view) at this
    node */
    public boolean isGroupExists(String groupId) 
                   throws WsrStorageException;


    /** Store a GroupInfo object. This method throws an exception under the
    following circumstances
    <br> The groupId in the GroupInfo already exists.
    <br> Storage related problems */
    public void storeCreatedGroup(WsrGroupInfoImpl groupInfo)
                throws WsrStorageException;
    /** Retrieves the GroupInfo corresponding to the specified 
    groupId. This method throws an exception under the following 
    conditions.
    <br> The Group specified in groupId is an unknown one.
    <br> Storage related problems */
    public WsrGroupInfoImpl getGroupInfoUsingGroupId(String GroupId)
                            throws WsrStorageException;
  
    /** Removes the GroupInfo corresponding to the specified 
    groupId. This method throws an exception under the following 
    conditions.
    <br> The Group specified in groupId is an unknown one.
    <br> Storage related problems */
    public void deleteGroupInfo(String GroupId)
                throws WsrStorageException;

    /** Retrieves the entire list of groupIds
    registered with the underlying service. This method throws an exception 
    if  there are storage related problems. */
    public String[] getListOfAllGroups(boolean isSource) 
                    throws WsrStorageException;
}